<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IBustLookupTable</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
<link rel="home" href="index.html" title="IBust Reference Manual">
<link rel="up" href="ch02.html" title="Panel (User Interfaces)">
<link rel="prev" href="IBustHotkeyProfile.html" title="IBustHotkeyProfile">
<link rel="next" href="IBustPanelService.html" title="IBustPanelService">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="IBustHotkeyProfile.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">IBust Reference Manual</th>
<td><a accesskey="n" href="IBustPanelService.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IBustLookupTable.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#IBustLookupTable.description" class="shortcut">Description</a>
                   | 
                  <a href="#IBustLookupTable.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="IBustLookupTable"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IBustLookupTable.top_of_page"></a>IBustLookupTable</span></h2>
<p>IBustLookupTable — Candidate word/phrase lookup table.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="IBustLookupTable.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="IBustLookupTable.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="IBustLookupTable.html#IBustLookupTable-struct" title="struct IBustLookupTable">IBustLookupTable</a>;
struct              <a class="link" href="IBustLookupTable.html#IBustLookupTableClass" title="struct IBustLookupTableClass">IBustLookupTableClass</a>;
<span class="returnvalue">void</span>                <a class="link" href="IBustLookupTable.html#ibust-lookup-table-append-candidate" title="ibust_lookup_table_append_candidate ()">ibust_lookup_table_append_candidate</a>  (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><a class="link" href="IBustText.html" title="IBustText"><span class="type">IBustText</span></a> *text</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="IBustLookupTable.html#ibust-lookup-table-append-label" title="ibust_lookup_table_append_label ()">ibust_lookup_table_append_label</a>      (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><a class="link" href="IBustText.html" title="IBustText"><span class="type">IBustText</span></a> *text</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="IBustLookupTable.html#ibust-lookup-table-clear" title="ibust_lookup_table_clear ()">ibust_lookup_table_clear</a>             (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="IBustLookupTable.html#ibust-lookup-table-cursor-down" title="ibust_lookup_table_cursor_down ()">ibust_lookup_table_cursor_down</a>       (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="IBustLookupTable.html#ibust-lookup-table-cursor-up" title="ibust_lookup_table_cursor_up ()">ibust_lookup_table_cursor_up</a>         (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);
<a class="link" href="IBustText.html" title="IBustText"><span class="returnvalue">IBustText</span></a> *          <a class="link" href="IBustLookupTable.html#ibust-lookup-table-get-candidate" title="ibust_lookup_table_get_candidate ()">ibust_lookup_table_get_candidate</a>     (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> index</code></em>);
<span class="returnvalue">guint</span>               <a class="link" href="IBustLookupTable.html#ibust-lookup-table-get-cursor-in-page" title="ibust_lookup_table_get_cursor_in_page ()">ibust_lookup_table_get_cursor_in_page</a>
                                                        (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);
<span class="returnvalue">guint</span>               <a class="link" href="IBustLookupTable.html#ibust-lookup-table-get-cursor-pos" title="ibust_lookup_table_get_cursor_pos ()">ibust_lookup_table_get_cursor_pos</a>    (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);
<a class="link" href="IBustText.html" title="IBustText"><span class="returnvalue">IBustText</span></a> *          <a class="link" href="IBustLookupTable.html#ibust-lookup-table-get-label" title="ibust_lookup_table_get_label ()">ibust_lookup_table_get_label</a>         (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> index</code></em>);
<span class="returnvalue">guint</span>               <a class="link" href="IBustLookupTable.html#ibust-lookup-table-get-number-of-candidates" title="ibust_lookup_table_get_number_of_candidates ()">ibust_lookup_table_get_number_of_candidates</a>
                                                        (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);
<span class="returnvalue">gint</span>                <a class="link" href="IBustLookupTable.html#ibust-lookup-table-get-orientation" title="ibust_lookup_table_get_orientation ()">ibust_lookup_table_get_orientation</a>   (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);
<span class="returnvalue">guint</span>               <a class="link" href="IBustLookupTable.html#ibust-lookup-table-get-page-size" title="ibust_lookup_table_get_page_size ()">ibust_lookup_table_get_page_size</a>     (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="IBustLookupTable.html#ibust-lookup-table-is-cursor-visible" title="ibust_lookup_table_is_cursor_visible ()">ibust_lookup_table_is_cursor_visible</a> (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="IBustLookupTable.html#ibust-lookup-table-is-round" title="ibust_lookup_table_is_round ()">ibust_lookup_table_is_round</a>          (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);
<a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="returnvalue">IBustLookupTable</span></a> *   <a class="link" href="IBustLookupTable.html#ibust-lookup-table-new" title="ibust_lookup_table_new ()">ibust_lookup_table_new</a>               (<em class="parameter"><code><span class="type">guint</span> page_size</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> cursor_pos</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> cursor_visible</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> round</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="IBustLookupTable.html#ibust-lookup-table-page-down" title="ibust_lookup_table_page_down ()">ibust_lookup_table_page_down</a>         (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="IBustLookupTable.html#ibust-lookup-table-page-up" title="ibust_lookup_table_page_up ()">ibust_lookup_table_page_up</a>           (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="IBustLookupTable.html#ibust-lookup-table-set-cursor-pos" title="ibust_lookup_table_set_cursor_pos ()">ibust_lookup_table_set_cursor_pos</a>    (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> cursor_pos</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="IBustLookupTable.html#ibust-lookup-table-set-cursor-visible" title="ibust_lookup_table_set_cursor_visible ()">ibust_lookup_table_set_cursor_visible</a>
                                                        (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> visible</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="IBustLookupTable.html#ibust-lookup-table-set-label" title="ibust_lookup_table_set_label ()">ibust_lookup_table_set_label</a>         (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> index</code></em>,
                                                         <em class="parameter"><code><a class="link" href="IBustText.html" title="IBustText"><span class="type">IBustText</span></a> *text</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="IBustLookupTable.html#ibust-lookup-table-set-orientation" title="ibust_lookup_table_set_orientation ()">ibust_lookup_table_set_orientation</a>   (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> orientation</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="IBustLookupTable.html#ibust-lookup-table-set-page-size" title="ibust_lookup_table_set_page_size ()">ibust_lookup_table_set_page_size</a>     (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> page_size</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="IBustLookupTable.html#ibust-lookup-table-set-round" title="ibust_lookup_table_set_round ()">ibust_lookup_table_set_round</a>         (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> round</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="IBustLookupTable.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----GInitiallyUnowned
         +----<a class="link" href="IBustObject.html" title="IBustObject">IBustObject</a>
               +----<a class="link" href="IBustSerializable.html" title="IBustSerializable">IBustSerializable</a>
                     +----IBustLookupTable
</pre>
</div>
<div class="refsect1">
<a name="IBustLookupTable.description"></a><h2>Description</h2>
<p>
An IBustLookuptable stores the candidate words or phrases for users to choose from.
</p>
<p>
Use <a class="link" href="IBustEngine.html#ibust-engine-update-lookup-table" title="ibust_engine_update_lookup_table ()"><code class="function">ibust_engine_update_lookup_table()</code></a>, <a class="link" href="IBustEngine.html#ibust-engine-show-lookup-table" title="ibust_engine_show_lookup_table ()"><code class="function">ibust_engine_show_lookup_table()</code></a>,
and <a class="link" href="IBustEngine.html#ibust-engine-hide-lookup-table" title="ibust_engine_hide_lookup_table ()"><code class="function">ibust_engine_hide_lookup_table()</code></a> to update, show and hide the lookup
table.
</p>
</div>
<div class="refsect1">
<a name="IBustLookupTable.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="IBustLookupTable-struct"></a><h3>struct IBustLookupTable</h3>
<pre class="programlisting">struct IBustLookupTable {
    guint page_size;
    guint cursor_pos;
    gboolean cursor_visible;
    gboolean round;
    gint orientation;

    GArray *candidates;
    GArray *labels;
};
</pre>
<p>
An IBustLookuptable stores the candidate words or phrases for users to choose from.
Note that some input methods allow you to select candidate by pressing non-numeric
keys such as "asdfghjkl;".
Developers of these input methods should change the labels with
<a class="link" href="IBustLookupTable.html#ibust-lookup-table-append-label" title="ibust_lookup_table_append_label ()"><code class="function">ibust_lookup_table_append_label()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><span class="type">guint</span> <em class="structfield"><code><a name="IBustLookupTable-struct.page-size"></a>page_size</code></em>;</span></p></td>
<td>number of candidate shown per page.</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">guint</span> <em class="structfield"><code><a name="IBustLookupTable-struct.cursor-pos"></a>cursor_pos</code></em>;</span></p></td>
<td>position index of cursor.</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">gboolean</span> <em class="structfield"><code><a name="IBustLookupTable-struct.cursor-visible"></a>cursor_visible</code></em>;</span></p></td>
<td>whether the cursor is visible.</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">gboolean</span> <em class="structfield"><code><a name="IBustLookupTable-struct.round"></a>round</code></em>;</span></p></td>
<td>TRUE for lookup table wrap around.</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">gint</span> <em class="structfield"><code><a name="IBustLookupTable-struct.orientation"></a>orientation</code></em>;</span></p></td>
<td>orientation of the table.</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">GArray</span> *<em class="structfield"><code><a name="IBustLookupTable-struct.candidates"></a>candidates</code></em>;</span></p></td>
<td>Candidate words/phrases.</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">GArray</span> *<em class="structfield"><code><a name="IBustLookupTable-struct.labels"></a>labels</code></em>;</span></p></td>
<td>Candidate labels which identify individual candidates in the same page. Default is 1, 2, 3, 4 ...</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="IBustLookupTableClass"></a><h3>struct IBustLookupTableClass</h3>
<pre class="programlisting">struct IBustLookupTableClass {
    IBustSerializableClass parent;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-append-candidate"></a><h3>ibust_lookup_table_append_candidate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ibust_lookup_table_append_candidate  (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><a class="link" href="IBustText.html" title="IBustText"><span class="type">IBustText</span></a> *text</code></em>);</pre>
<p>
Append a candidate word/phrase to IBustLookupTable, and increase reference.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>candidate word/phrase to be appended (in IBustText format).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-append-label"></a><h3>ibust_lookup_table_append_label ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ibust_lookup_table_append_label      (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><a class="link" href="IBustText.html" title="IBustText"><span class="type">IBustText</span></a> *text</code></em>);</pre>
<p>
Append a candidate word/phrase to IBustLookupTable, and increase reference.
This function is needed if the input method select candidate with
non-numeric keys such as "asdfghjkl;".
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>A candidate label to be appended (in IBustText format).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-clear"></a><h3>ibust_lookup_table_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ibust_lookup_table_clear             (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);</pre>
<p>
Clear and remove all candidate from an IBustLookupTable.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-cursor-down"></a><h3>ibust_lookup_table_cursor_down ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            ibust_lookup_table_cursor_down       (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);</pre>
<p>
Go to next candidate of an IBustLookupTable.
</p>
<p>
It returns FALSE if it is already at the last candidate,
unless  <code class="code">table&gt;-round==TRUE</code>, where it will go
to the first candidate.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if succeed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-cursor-up"></a><h3>ibust_lookup_table_cursor_up ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            ibust_lookup_table_cursor_up         (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);</pre>
<p>
Go to previous candidate of an IBustLookupTable.
</p>
<p>
It returns FALSE if it is already at the first candidate,
unless  <code class="code">table&gt;-round==TRUE</code>, where it will go
to the last candidate.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if succeed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-get-candidate"></a><h3>ibust_lookup_table_get_candidate ()</h3>
<pre class="programlisting"><a class="link" href="IBustText.html" title="IBustText"><span class="returnvalue">IBustText</span></a> *          ibust_lookup_table_get_candidate     (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> index</code></em>);</pre>
<p>
Return IBustText at the given index. Borrowed reference.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
<td>Index in the Lookup table.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>IBustText at the given index; NULL if no such IBustText. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-get-cursor-in-page"></a><h3>ibust_lookup_table_get_cursor_in_page ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>               ibust_lookup_table_get_cursor_in_page
                                                        (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);</pre>
<p>
Get the cursor position in current page of IBustLookupTable.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The position of cursor in current page.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-get-cursor-pos"></a><h3>ibust_lookup_table_get_cursor_pos ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>               ibust_lookup_table_get_cursor_pos    (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);</pre>
<p>
Get the cursor position of IBustLookupTable.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The position of cursor.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-get-label"></a><h3>ibust_lookup_table_get_label ()</h3>
<pre class="programlisting"><a class="link" href="IBustText.html" title="IBustText"><span class="returnvalue">IBustText</span></a> *          ibust_lookup_table_get_label         (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> index</code></em>);</pre>
<p>
Return IBustText at the given index. Borrowed reference.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
<td>Index in the Lookup table.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>IBustText at the given index; NULL if no such IBustText. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-get-number-of-candidates"></a><h3>ibust_lookup_table_get_number_of_candidates ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>               ibust_lookup_table_get_number_of_candidates
                                                        (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);</pre>
<p>
Return the number of candidate in the table.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of candidates in the table</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-get-orientation"></a><h3>ibust_lookup_table_get_orientation ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>                ibust_lookup_table_get_orientation   (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);</pre>
<p>
Returns the orientation of the IBustLookupTable.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The orientation of the <em class="parameter"><code>table</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-get-page-size"></a><h3>ibust_lookup_table_get_page_size ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>               ibust_lookup_table_get_page_size     (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);</pre>
<p>
Get the number of candidate shown per page.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Page size, i.e., number of candidate shown per page.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-is-cursor-visible"></a><h3>ibust_lookup_table_is_cursor_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            ibust_lookup_table_is_cursor_visible (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);</pre>
<p>
Returns whether the cursor of an IBustLookupTable is visible.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Whether the cursor of <em class="parameter"><code>table</code></em> is visible.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-is-round"></a><h3>ibust_lookup_table_is_round ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            ibust_lookup_table_is_round          (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);</pre>
<p>
Returns whether the IBustLookupTable is round.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Whether the <em class="parameter"><code>table</code></em> is round.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-new"></a><h3>ibust_lookup_table_new ()</h3>
<pre class="programlisting"><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="returnvalue">IBustLookupTable</span></a> *   ibust_lookup_table_new               (<em class="parameter"><code><span class="type">guint</span> page_size</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> cursor_pos</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> cursor_visible</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> round</code></em>);</pre>
<p>
New a IBustLookupTable.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>page_size</code></em> :</span></p></td>
<td>number of candidate shown per page, the max value is 16.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cursor_pos</code></em> :</span></p></td>
<td>position index of cursor.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cursor_visible</code></em> :</span></p></td>
<td>whether the cursor is visible.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>round</code></em> :</span></p></td>
<td>TRUE for lookup table wrap around.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly allocated IBustLookupTable.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-page-down"></a><h3>ibust_lookup_table_page_down ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            ibust_lookup_table_page_down         (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);</pre>
<p>
Go to next page of an IBustLookupTable.
</p>
<p>
It returns FALSE if it is already at the last page,
unless  <code class="code">table&gt;-round==TRUE</code>, where it will go
to the first page.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if succeed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-page-up"></a><h3>ibust_lookup_table_page_up ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            ibust_lookup_table_page_up           (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>);</pre>
<p>
Go to previous page of an IBustLookupTable.
</p>
<p>
It returns FALSE if it is already at the first page,
unless  <code class="code">table&gt;-round==TRUE</code>, where it will go
to the last page.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if succeed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-set-cursor-pos"></a><h3>ibust_lookup_table_set_cursor_pos ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ibust_lookup_table_set_cursor_pos    (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> cursor_pos</code></em>);</pre>
<p>
Set the cursor position of IBustLookupTable.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cursor_pos</code></em> :</span></p></td>
<td>The position of cursor.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-set-cursor-visible"></a><h3>ibust_lookup_table_set_cursor_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ibust_lookup_table_set_cursor_visible
                                                        (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> visible</code></em>);</pre>
<p>
Set whether to make the cursor of an IBustLookupTable visible or not.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>visible</code></em> :</span></p></td>
<td>Whether to make the cursor of <em class="parameter"><code>table</code></em> visible.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-set-label"></a><h3>ibust_lookup_table_set_label ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ibust_lookup_table_set_label         (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> index</code></em>,
                                                         <em class="parameter"><code><a class="link" href="IBustText.html" title="IBustText"><span class="type">IBustText</span></a> *text</code></em>);</pre>
<p>
Append a candidate word/phrase to IBustLookupTable, and increase reference.
This function is needed if the input method select candidate with
non-numeric keys such as "asdfghjkl;".
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
<td>Intex in the Lookup table.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>A candidate label to be appended (in IBustText format).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-set-orientation"></a><h3>ibust_lookup_table_set_orientation ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ibust_lookup_table_set_orientation   (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> orientation</code></em>);</pre>
<p>
Set the orientation.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>orientation</code></em> :</span></p></td>
<td>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-set-page-size"></a><h3>ibust_lookup_table_set_page_size ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ibust_lookup_table_set_page_size     (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> page_size</code></em>);</pre>
<p>
Set the number of candidate shown per page.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page_size</code></em> :</span></p></td>
<td>number of candidate shown per page.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-lookup-table-set-round"></a><h3>ibust_lookup_table_set_round ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ibust_lookup_table_set_round         (<em class="parameter"><code><a class="link" href="IBustLookupTable.html" title="IBustLookupTable"><span class="type">IBustLookupTable</span></a> *table</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> round</code></em>);</pre>
<p>
Set whether to make the IBustLookupTable round or not.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td>An IBustLookupTable.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>round</code></em> :</span></p></td>
<td>Whether to make <em class="parameter"><code>table</code></em> round.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="IBustLookupTable.see-also"></a><h2>See Also</h2>
<a class="link" href="IBustEngine.html" title="IBustEngine"><span class="type">IBustEngine</span></a>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>